GetCustomFormFields (Method)

Description

Returns custom form fields linked to a sales order header, sorted by the specified column name. Introduced in v2.21.

Request (GetCustomFormFieldsSoapIn)

The request body is of type GetCustomFormFields.

Request Body Parameters

Name	Description	Data Type
OrderNumber	The sales order number to query.	xml:string
CustomFields	Comma-separated list of Custom Form Field (CFF) names to query.	xml:string
SortColumnNames	A sales order SorMaster+ column name to use as an ascending sort column.	xml:string

Example

Javascript

// Example: get order custom form fields with column names of
//          ShipmentTracking, InvoiceNumber, and LoanType
//          from sales order 4145

MakeAJAXCall("Order.GetCustomFormFields",{
    OrderNumber: '4145', 
    CustomFields: 'ShipmentTracking,InvoiceNumber,LoanType', 
    SortColumnNames: 'InvoiceNumber'
},console.log)

200 Response (GetCustomFormFieldsSoapOut)

The response body is of type GetCustomFormFieldsResponse.

Response Body Parameters

Name	Description	Data Type
GetCustomFormFieldsResult	A string value containing a JSON object. { "Data": { "CustomFormFields": [ { "ShipmentTracking": "", "InvoiceNumber": "", "LoanType": "Event Loan" } ] }, "Result": { "Success": true, "Message": "Results returned successfully.", "ElapsedTime": "283 ms" } }	xml:string

Name

Description

Data Type

GetCustomFormFieldsResult

A string value containing a JSON object.

{
    "Data": {
        "CustomFormFields": [
            {
                "ShipmentTracking": "",
                "InvoiceNumber": "",
                "LoanType": "Event Loan"
            }
        ]
    },
    "Result": {
        "Success": true,
        "Message": "Results returned successfully.",
        "ElapsedTime": "283 ms"
    }
}

xml:string